home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / vmstat / RCS / vmstat.man,v < prev   
Encoding:
Text File  |  1990-07-03  |  16.8 KB  |  430 lines
  1. head     1.3;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.3
  10. date     90.07.03.16.26.45;  author mendel;  state Exp;
  11. branches ;
  12. next     1.2;
  13.  
  14. 1.2
  15. date     88.12.30.10.28.58;  author ouster;  state Exp;
  16. branches ;
  17. next     1.1;
  18.  
  19. 1.1
  20. date     88.12.22.13.20.02;  author ouster;  state Exp;
  21. branches ;
  22. next     ;
  23.  
  24.  
  25. desc
  26. @@
  27.  
  28.  
  29. 1.3
  30. log
  31. @Added decStation 3100 based stats.
  32. @
  33. text
  34. @' $Header: /sprite/src/cmds/vmstat/RCS/vmstat.man,v 1.2 88/12/30 10:28:58 ouster Exp Locker: mendel $ SPRITE (Berkeley)
  35. .so \*(]ltmac.sprite
  36. .HS VMSTAT cmds
  37. .BS
  38. .SH NAME
  39. vmstat \- print virtual memory stats
  40. .SH SYNOPSIS
  41. \fBvmstat \fR[\fB\-svmP\fR] [\fB\-t \fIinterval\fR] [\fB\-T \fImaxSkip\fR] [\fB\-l \fIlines\fR] [\fB\-fp \fIthreshold\fR]
  42. .SH OPTIONS
  43. .IP "\fB\-s\fR" 14
  44. Print out statistics about all in-use segments instead of overall vm stats.
  45. .IP "\fB\-v\fR" 14
  46. Print out extra information when printing overall vm stats.
  47. .IP "\fB\-t \fIinterval\fR" 14
  48. Print out a line of terse vm stats every \fIinterval\fR seconds.  If 
  49. \fIinterval\fR is specified as 0 then only a single line is printed.
  50. .IP "\fB\-m\fR" 14
  51. Print out the number of modified pages instead of kernel stack pages when using
  52. the \fB\-t\fR option.
  53. .IP "\fB\-l \fInumLines\fR" 14
  54. Print out \fInumLines\fR lines before printing the header again when
  55. using the \fB\-t\fR option.
  56. The default is 25 lines.
  57. .IP "\fB\-f \fIthreshold\fR" 14
  58. Number of page faults per second before should print out stats with 
  59. the \fB\-t\fR option.
  60. No lines will be printed unless more than \fIthreshold\fR page faults occur
  61. or the \fB\-p\fR or \fB\-T\fR options are in effect.
  62. .IP "\fB\-p \fIthreshold\fR" 14
  63. Number of page-outs per second before should print out stats with the 
  64. \fB\-t\fR option.
  65. No lines will be printed unless more than \fIthreshold\fR page-outs occur
  66. or the \fB\-f\fR or \fB\-T\fR options are in effect.
  67. .IP "\fB\-T \fImaxSkip\fR" 14
  68. Maximum number of times to skip printing out statistics because of the
  69. \fB\-f\fR and \fB\-p\fR options.
  70. .IP "\fB\-P\fI" 14
  71. Print out statistics since the last time that they were printed, not
  72. since the last interval.  Used with the \fB\-t\fR option.
  73. .BE
  74.  
  75. .SH DESCRIPTION
  76. .LP
  77. This command prints out virtual memory statistics.  There are three
  78. possible formats and types of information that are printed.
  79. The default is to print overall virtual memory
  80. statistics; the volume of statistics that are printed is controlled by
  81. the \fB\-v\fR option.  If the \fB\-s\fR option is specified then statistics about
  82. all actively used segments are printed instead.  If the \fB\-t\fR option
  83. is specified then a terse line of information is printed at regular
  84. intervals;  the \fB\-TlfpPm\fR options control how the data is formatted
  85. and how often it is printed.
  86. The next three sections describe the three printing formats in more detail.
  87. .SH "GENERAL STATISTICS"
  88. By default \fBvmstat\fR prints out general statistics about the virtual memory 
  89. system.  If the \fB\-v\fR option is specified then more detailed statistics
  90. will be printed.  The normal information that is printed is divided into
  91. 5 sections: memory use, segment use, page fault statistics, page-out 
  92. statistics and copy-on-write activity.  The memory use section is titled
  93. ``MEMORY STATS'' and contains 6 lines of information with the following
  94. titles and information:
  95. .IP "\fIPage Size\fR" 15
  96. The logical page size; this is a multiple of the physical page size.
  97. .IP "\fIMemory Size\fR" 15
  98. The amount of physical memory in Kbytes that is available on the machine.
  99. .IP "\fIKernel Memory\fR" 15
  100. The amount of memory in Kbytes that is being used by the kernel.  There are
  101. four pieces of information on this line (from left to right):
  102. the total amount of memory used by the kernel, the portion of the total
  103. that is used for kernel 
  104. code and data, the portion used for kernel stacks and the portion that is 
  105. kept in emergency reserve.
  106. .IP "\fIUser Memory\fR" 15
  107. The amount of memory in Kbytes that is being used by user processes.  There
  108. are 3 pieces of information on this line (from left to right):
  109. the total amount of memory used by user processes, the portion of the total
  110. that is dirty and the portion that is clean. 
  111. .IP "\fIFS Memory\fR" 15
  112. The amount of memory in Kbytes that is being used by the file system.
  113. The 3 pieces of information on this line are (from left to right): the
  114. total amount of memory used by the file system, the minimum amount of memory
  115. that has ever been used and the maximum amount that has been used.
  116. .IP "\fIFree Memory\fR" 15
  117. The amount of memory in Kbytes that is not being used by anyone.
  118. .LP
  119. The second section of statistics is entitled ``SEGMENT STATS''.  This section
  120. contains four lines of information, one each for active code segments,
  121. inactive code segments, heap segments and stack segments.  Each contains
  122. the number of segments of the given type and the amount of memory in 
  123. Kbytes that is being used by the particular type of segment.
  124. .LP
  125. The third section of statistics is entitled ``FAULT STATS''.  The first
  126. line contains the total number of faults.  The second line divides the
  127. total faults into the 7 different types of faults:
  128. .IP "\fIZero\fR" 10
  129. Pages that are filled with zeroes.
  130. .IP "\fIFS\fR" 10
  131. Pages that are filled from an object file in the file system.
  132. .IP "\fISwap\fR" 10
  133. Pages that are filled from a swap file.
  134. .IP "\fIQuick\fR" 10
  135. Page faults that were handled merely by validating the page in hardware.
  136. .IP "\fICOW\fR" 10
  137. Copy-on-write faults.
  138. .IP "\fICOR\fR" 10
  139. Copy-on-reference faults.
  140. .IP "\fICOR-mod\fR" 10
  141. Faults that occured because pages that were filled because of copy-on-reference
  142. faults were marked as read-only.  This is done to compare copy-on-reference
  143. to copy-on-write (see \fIvmcmd\fR for details).
  144. .LP
  145. The third line divides the faults into the different segments that the
  146. faults occured in.  The last line is the number of faults that collided with
  147. another process faulting on the same page.
  148. .LP
  149. The fourth section which is entitled ``PAGE-OUTS'' contains the number of
  150. pages that were written to swap space.
  151. .LP
  152. The last section is entitled ``COPY-ON-WRITE'' and contains statistics
  153. about copy-on-write and copy-on-reference behavior.  The information in
  154. this section is presented as the number of faults that occured divided
  155. by the number of copy-on-write or copy-on-reference pages.  Statistics
  156. are presented for both heap and stack segments separately (the entries
  157. are labeled \fIHeap\fR and \fIStack\fR respectively) and for the sum
  158. of the heap and stack statistics (labeled \fITot\fR).  The first two
  159. lines contain information about copy-on-write (COW) behavior, the second
  160. two about copy-on-reference (COR) behavior and the last two 
  161. about the percentage
  162. of pages that were copied because of copy-on-reference faults that were
  163. eventually modified (COR-mod).  The information about COW behavior contains
  164. an additional statistic labeled \fIQuick\fR which is the number of 
  165. copy-on-write faults that were handled by merely changing the protection;
  166. no copy was required.
  167. .LP
  168. When the \fB\-v\fR option is specified additional results are presented.
  169. These results are more obscure and are probably only of interest to those who
  170. understand the internals of the Sprite virtual memory system.  The first
  171. additional statistic is a measurement of the need for modify bits
  172. and is given under the ``MEMORY STATS'' section.  This line of statistics
  173. which is labeled \fIMod page stats\fR gives three bits of information.
  174. The first entry (labeled \fIPot-mod\fR) is the number of
  175. page frames that were being actively used by heap and stack segments
  176. that were taken away from the segment and given to another segment; since
  177. these segments are writable, the pages in these segments are potentially
  178. modified.
  179. The second entry (labeled \fINot-mod\fR) is the number of potentially modified
  180. pages that were clean.  The last entry (labeled 
  181. \fINot-hard-mod\fR) is the number of potentially modified pages that did
  182. not have the hardware modify bit set; pages can be marked as modified by
  183. the virtual memory system (e.g. zero-filled pages) even though they do not
  184. have the modify bit set by the hardware.
  185. .LP
  186. The second extra set of statistics is under the ``PAGE-OUTS'' section.  The
  187. first extra line which is labeled \fIClean-wait\fR is the number of times that
  188. processes that were exiting had to wait because a page that they were
  189. freeing was being cleaned.  The second line labeled \fICleaner starts\fR 
  190. is the number of times that a page cleaner was started up to write out
  191. pages.
  192. .LP
  193. The remaining extra statistics that are printed with the \fB\-v\fR option
  194. are under entirely different sections.  The first section which is
  195. entitled ``ALLOCATION STATS'' gives statistics about the allocation of
  196. memory.  The first line which is labeled \fIVm allocs\fR gives the
  197. following information (from left to right): the total number of pages that
  198. were allocated, the portion of this total that came from the free list,
  199. the portion that came from the file system and the portion that came from
  200. the allocate list.  The second line which is labeled \fIVM-FS stats\fR gives
  201. statistics about the virtual memory and file system negotiation.  The
  202. first two entries give the number
  203. of times that the file system asked the virtual memory system for the
  204. age of its oldest page (labeled \fIFS-asked\fR) and the number of these 
  205. times that a free page was available (labeled \fIHad-free-page\fR).
  206. The second two entries give the number of pages that the file system added
  207. to its cache and the number of pages that it deleted from its cache
  208. (labeled \fIFS-map\fR and \fIFS-unmap\fR respectively).
  209. .LP
  210. The next two lines of statistics under the ``ALLOCATION STATS'' section
  211. contains information about searching the memory lists.  The
  212. first line gives how many times that the lists were searched for pages and
  213. how many times the memory was found on the free list and how many times
  214. it was found on the allocation list (labeled \fIFree\fR and \fIIn-use\fR
  215. respectively).  The second line gives information about why multiple
  216. iterations through the allocation list were required; most of the time
  217. the first element on the list can be used.  This line contains the
  218. following information from left to right: the total number of extra searches,
  219. the portion of extra searches that were required because
  220. the page frame was locked (labeled \fILock\fR), the page frame was
  221. referenced (\fIlabeled \fIRef\fR) or the page frame was dirty
  222. (\fIDirty\fR).
  223. .LP
  224. The next section of statistics is entitled ``LIST STATS''.  This
  225. section gives the current number of pages that are
  226. on each of the four memory list.
  227. .LP
  228. The next section is labeled ``PAGE MAPPING STATS''.  This section gives
  229. the number of times a process had to wait because the fixed number of slots
  230. that are used to map user pages into the kernel's virtual address spacce
  231. were all in use.
  232. .LP
  233. The last section is entitled ``HARDWARE STATS'' and contains
  234. information that depends on the hardware.  For Sun workstations it
  235. contains statistics about many times one of the 8 hardware contexts had
  236. to be taken away from one process and given to another and the number
  237. of times that a hardware PMEG had to be taken away from one segment and
  238. given to another. For MIPS R2000/R3000 based machines such as
  239. DecStations, the number of times TLB pids were stolen from active processes
  240. is reported.
  241. .SH "SEGMENT STATISTICS"
  242. .LP
  243. When the \fI-s\fR option is given to \fBvmstat\fR then statistics about all 
  244. in use segments are printed.  There are 6 columns of information:
  245. .IP \fISEG-NUM\fR 20
  246. The segment number.
  247. .IP \fITYPE\fR 20
  248. The type of segment.  The segment type can be
  249. \fIInactive\fR for inactive code segments or \fICode\fR, \fIHeap\fR  or
  250. \fIStack\fR for the other three types of segments.
  251. .IP \fISIZE\fR 20
  252. The total size of the segment's virtual addres space in Kbytes.
  253. .IP \fIRES-SIZE\fR 20
  254. The amount of physical memory occupied by the segment in Kbytes.
  255. .IP \fINUM-REFS\fR 20
  256. The number of processes that are actively using this segment.
  257. .IP \fIOBJECT-FILE-NAME\fR 20
  258. The name of the object file that the code segment is being demand loaded
  259. from.
  260. .LP
  261. After the information about each individual segment is printed a summary
  262. of the segment information is printed.
  263. .SH "STATISTICS AT REGULAR INTERVALS"
  264. .LP
  265. If the \fB\-t \fIinterval\fR option is given to \fBvmstat\fR then a line of 
  266. terse statistics is printed out at regular intervals.  If \fIinterval\fR is 0 
  267. then only a single line of statistics is printed.  If \fIinterval\fR is
  268. greater than 0 then a line of statistics is printed out every
  269. \fIinterval\fR seconds.  If the \fB\-f \fIfaultThreshold\fR and/or
  270. \fB\-p \fIpageoutThreshold\fR options are used then statistics will be
  271. checked every \fIinterval\fR seconds but only will be printed out
  272. if the number of page faults in the last interval is greater than 
  273. \fIfaultThreshold\fR or the number of pageouts is greater than 
  274. \fIpageoutThreshold\fR.  If the \fB\-T \fImaxSkip\fR option is used then
  275. statistics will be printed out at least every \fImaxSkip\fR intervals
  276. regardless whether or not enough page-outs or page faults have occured.
  277. .LP
  278. All memory use statistics are printed in units of 1024 bytes.
  279. Each line contains 10 columns of information:
  280. .IP \fIAVAIL\fR 10
  281. The total amount of physical memory available.
  282. .IP \fIFREE\fR 10
  283. The amount of memory that is not being used by anyone.
  284. .IP \fIUSER\fR 10
  285. The amount of memory that is being used by user processes.
  286. .IP \fIKMEM\fR 10
  287. The amount of memory that is being used by the kernel for code and data.
  288. .IP \fIKSTK\fR 10
  289. The amount of memory that is being used for kernel stacks.
  290. .IP \fIFS$\fR 10
  291. The size of the file system cache.
  292. .IP \fIPF-NUM\fR 10
  293. The number of page faults that have occured. 
  294. .IP \fIPF-SWP\fR 10
  295. The number of page faults that were filled from swap space.
  296. .IP \fIPF-FS\fR 10
  297. The number of page faults that were filled from the file system.
  298. .IP \fIPOUTS\fR 10
  299. The number of pages that were written to swap space.
  300. .LP
  301. If the \fB\-m\fR option is specified then the \fIKSTK\fR column will be
  302. replaced by a column labeled \fIMOD%\fR which contains the percentage
  303. of user memory that is modified.  The number of kernel stack pages
  304. will be added into the statistics under the \fIKMEM\fR column.
  305. .LP
  306. By default a new column header line will be printed after 25 lines of
  307. output.  The \fB\-l \fIlines\fR option can be used to force the header line
  308. to be printed after \fIlines\fR lines of output are printed.
  309. .LP
  310. The number of page faults and page-outs that are printed are by default
  311. the number since the last interval.  However, many intervals can
  312. be skipped because of the \fB\-f\fR and \fB\-p\fR options.  The
  313. \fB\-P\fR option will force \fBvmstat\fR to print out the number of faults and
  314. pageouts since the last time that a line was printed instead of since the 
  315. last interval.
  316. .SH KEYWORDS
  317. virtual memory, statistics
  318. @
  319.  
  320.  
  321. 1.2
  322. log
  323. @More format upgrades.
  324. @
  325. text
  326. @d1 1
  327. a1 1
  328. ' $Header: /a/newcmds/vmstat/RCS/vmstat.man,v 1.1 88/12/22 13:20:02 ouster Exp Locker: ouster $ SPRITE (Berkeley)
  329. d205 3
  330. a207 1
  331. given to another.
  332. @
  333.  
  334.  
  335. 1.1
  336. log
  337. @Initial revision
  338. @
  339. text
  340. @d1 1
  341. a1 1
  342. ' $Header: vmstat,v 1.1 88/08/15 15:53:07 nelson Exp $ SPRITE (Berkeley)
  343. d8 1
  344. a8 1
  345. \fBvmstat \fR[\fB-svmP\fR] [\fB-t \fIinterval\fR] [\fB-T \fImaxSkip\fR] [\fB-l \fIlines\fR] [\fB-fp \fIthreshold\fR]
  346. d10 1
  347. a10 1
  348. .IP "\fB-s\fR" 14
  349. d12 1
  350. a12 1
  351. .IP "\fB-v\fR" 14
  352. d14 1
  353. a14 1
  354. .IP "\fB-t \fIinterval\fR" 14
  355. d17 1
  356. a17 1
  357. .IP "\fB-m\fR" 14
  358. d19 2
  359. a20 2
  360. the \fB-t\fR option.
  361. .IP "\fB-l \fInumLines\fR" 14
  362. d22 1
  363. a22 1
  364. using the \fB-t\fR option.
  365. d24 1
  366. a24 1
  367. .IP "\fB-f \fIthreshold\fR" 14
  368. d26 1
  369. a26 1
  370. the \fB-t\fR option.
  371. d28 2
  372. a29 2
  373. or the \fB-p\fR or \fB-T\fR options are in effect.
  374. .IP "\fB-p \fIthreshold\fR" 14
  375. d31 1
  376. a31 1
  377. \fB-t\fR option.
  378. d33 2
  379. a34 2
  380. or the \fB-f\fR or \fB-T\fR options are in effect.
  381. .IP "\fB-T \fImaxSkip\fR" 14
  382. d36 2
  383. a37 2
  384. \fB-f\fR and \fB-p\fR options.
  385. .IP "\fB-P\fI" 14
  386. d39 1
  387. a39 1
  388. since the last interval.  Used with the \fB-t\fR option.
  389. d48 2
  390. a49 2
  391. the \fB-v\fR option.  If the \fB-s\fR option is specified then statistics about
  392. all actively used segments are printed instead.  If the \fB-t\fR option
  393. d51 1
  394. a51 1
  395. intervals;  the \fB-TlfpPm\fR options control how the data is formatted
  396. d55 2
  397. a56 2
  398. By default vmstat prints out general statistics about the virtual memory 
  399. system.  If the \fB-v\fR option is specified then more detailed statistics
  400. d135 1
  401. a135 1
  402. When the \fB-v\fR option is specified additional results are presented.
  403. d160 1
  404. a160 1
  405. The remaining extra statistics that are printed with the \fB-v\fR option
  406. d208 1
  407. a208 1
  408. When the \fI-s\fR option is given to vmstat then statistics about all 
  409. d230 1
  410. a230 1
  411. If the \fB-t \fIinterval\fR option is given to vmstat then a line of 
  412. d234 2
  413. a235 2
  414. \fIinterval\fR seconds.  If the \fB-f \fIfaultThreshold\fR and/or
  415. \fB-p \fIpageoutThreshold\fR options are used then statistics will be
  416. d239 1
  417. a239 1
  418. \fIpageoutThreshold\fR.  If the \fB-T \fImaxSkip\fR option is used then
  419. d266 1
  420. a266 1
  421. If the \fB-m\fR option is specified then the \fIKSTK\fR column will be
  422. d272 1
  423. a272 1
  424. output.  The \fB-l \fIlines\fR option can be used to force the header line
  425. d277 2
  426. a278 2
  427. be skipped because of the \fB-f\fR and \fB-p\fR options.  The
  428. \fB-P\fR option will force vmstat to print out the number of faults and
  429. @
  430.